////////////////////////////////////////////////////////////////////////////////
// Copyright 2010 Michael Schmalle - Teoti Graphix, LLC
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0 
// 
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and 
// limitations under the License
// 
// Author: Michael Schmalle, Principal Architect
// mschmalle at teotigraphix dot com
////////////////////////////////////////////////////////////////////////////////

package org.teotigraphix.swizplugin.core
{

import mx.core.IMXMLObject;

[DefaultProperty("children")]

/**
 * The <code>PluginOptions</code> is a base class for creating plugin 
 * configuration MXML tags and actionscript instances.
 * 
 * @author Michael Schmalle
 * @copyright Teoti Graphix, LLC
 * @productversion 1.0
 */
public dynamic class PluginOptions implements IMXMLObject
{
	/**
	 * The unique id of the tag.
	 */
	public var uid:String;
	
	/**
	 * The name of the tag, usually set in the constructor, but if this
	 * class is used, can be dynamically set in the MXML tag.
	 */
	public var name:String;
	
	//--------------------------------------------------------------------------
	//
	//  Public :: Properties
	//
	//--------------------------------------------------------------------------
	
	//----------------------------------
	//  children
	//----------------------------------
	
	/**
	 * @private
	 */
	private var _children:Array;
	
	/**
	 * @copy swizplugin.plugin.IPluginOptions#children
	 */
	public function get children():Array
	{
		return _children;
	}
	
	/**
	 * @private
	 */
	public function set children(value:Array):void
	{
		_children = value;
	}
	
	//--------------------------------------------------------------------------
	//
	//  Constructor
	//
	//--------------------------------------------------------------------------
	
	/**
	 * Constructor.
	 */
	public function PluginOptions()
	{
	}
	
	//--------------------------------------------------------------------------
	//
	//  IMXMLObject API :: Methods
	//
	//--------------------------------------------------------------------------
	
	/**
	 * @private
	 */
	public function initialized(document:Object, id:String):void
	{
	}
	
	/**
	 * This the option's public enumerations.
	 */
	public function listEnumerations():Array
	{
		return ["uid", "name"];
	}
}
}